//-----------------------------------------------------------------------------
//
//	ValueBool.h
//
//	Represents a boolean value
//
//	Copyright (c) 2010 Mal Lansell <openzwave@lansell.org>
//
//	SOFTWARE NOTICE AND LICENSE
//
//	This file is part of OpenZWave.
//
//	OpenZWave is free software: you can redistribute it and/or modify
//	it under the terms of the GNU Lesser General Public License as published
//	by the Free Software Foundation, either version 3 of the License,
//	or (at your option) any later version.
//
//	OpenZWave is distributed in the hope that it will be useful,
//	but WITHOUT ANY WARRANTY; without even the implied warranty of
//	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//	GNU Lesser General Public License for more details.
//
//	You should have received a copy of the GNU Lesser General Public License
//	along with OpenZWave.  If not, see <http://www.gnu.org/licenses/>.
//
//-----------------------------------------------------------------------------

#ifndef _ValueBool_H
#define _ValueBool_H

#include <string>
#include "Defs.h"
#include "value_classes/Value.h"

class TiXmlElement;

namespace OpenZWave
{
	namespace Internal
	{
		namespace VC
		{

			/** \brief Boolean value sent to/received from a node.
			 * \ingroup ValueID
			 */
			class ValueBool: public Value
			{
				public:
					ValueBool(uint32 const _homeId, uint8 const _nodeId, ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _index, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, bool const _value, uint8 const _pollIntensity);
					ValueBool()
					{
					}
					virtual ~ValueBool()
					{
					}

					bool Set(bool const _value);
					void OnValueRefreshed(bool const _value);
					void ConfirmNewValue()
					{
						OnValueRefreshed(m_newValue != 0);
					};
					void SetTargetValue(bool const _target, uint32 _duration = 0);


					// From Value
					virtual string const GetAsString() const
					{
						return (GetValue() ? "True" : "False");
					}
					virtual bool SetFromString(string const& _value);
					virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const* _valueElement);
					virtual void WriteXML(TiXmlElement* _valueElement);

					bool GetValue() const
					{
						return m_value;
					}

				private:
					bool m_value;				// the current index in the m_items vector
					bool m_valueCheck;			// the previous value (used for double-checking spurious value reads)
					bool m_targetValue;			// The Target Value
					bool m_newValue;			// a new value to be set on the appropriate device (used by Supervision CC)
			};
		} // namespace VC
	} // namespace Internal
} // namespace OpenZWave

#endif

